﻿/****************************************************************************************************
	Copyright (C) 2010 RapidWebDev Organization (http://rapidwebdev.org)
	Author: Eunge, Legal Name: Jian Liu, Email: eunge.liu@RapidWebDev.org

	This program is free software: you can redistribute it and/or modify
	it under the terms of the GNU General Public License as published by
	the Free Software Foundation, either version 2 of the License, or
	(at your option) any later version.

	This program is distributed in the hope that it will be useful,
	but WITHOUT ANY WARRANTY; without even the implied warranty of
	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
	GNU General Public License for more details.

	You should have received a copy of the GNU General Public License
	along with this program.  If not, see <http://www.gnu.org/licenses/>.
 ****************************************************************************************************/

using System;
using System.Collections.Generic;
using System.Collections.ObjectModel;
using System.Globalization;
using System.Linq;
using System.Runtime.Serialization;
using System.Text;

namespace RapidWebDev.SearchIndex.Contract
{
	/// <summary>
	/// Index document field message.
	/// </summary>
	[Serializable]
	[DataContract(Namespace = ServiceNamespaces.SearchIndexNamespace)]
	public class IndexDocFieldMessage
	{
		/// <summary>
		/// The field name.
		/// </summary>
		[DataMember]
		public string Name { get; set; }

		/// <summary>
		/// Whether the field is sortable.
		/// </summary>
		[DataMember]
		public bool Sortable { get; set; }

		/// <summary>
		/// Index document field value types.
		/// </summary>
		[DataMember]
		public IndexDocFieldValueTypes Type { get; set; }

		/// <summary>
		/// Index document field values.
		/// </summary>
		[DataMember]
		public Collection<string> Values { get; set; }

		/// <summary>
		/// Convert the object to string.
		/// </summary>
		/// <returns></returns>
		public override string ToString()
		{
			string s = "";
			if (this.Values != null)
			{
				foreach (string value in Values)
				{
					if (s.Length != 0) s += "; ";
					s += value;
				}
			}

			return string.Format(CultureInfo.InvariantCulture, "{0}: {1}", this.Name, s);
		}
	}
}